Changes to CONTRIBUTING.md #1261

unjust · 2022-11-18T16:24:44Z

Tenemos un wiki con contenido y varios READMEs que podemos linkear/actualizar para describir el proceso de contributing mas clara.

https://github.com/unjust/bootcamp/blob/contributing_wiki_1249/CONTRIBUTING.md
https://github.com/unjust/bootcamp/blob/contributing_wiki_1249/DEPLOYMENT.md

Agregamos secciones a CONTRIBUTING con contenido de wiki y como contribuir contenido en particular (topics, projects, OAs)
Agregamos pasos que falta a DEPLOYMENT
Linkear contributing al README principal
Borrar partes a wiki repetidas en el readme, pero quiza quedamos con styleguides alla, y linkeamos esos al README contributing

CONTRIBUTING.md

lupomontero

Gracias por el PR @unjust ⭐

He dejado algunos comentarios con algunas sugerencias 💪

CONTRIBUTING.md

…ing_wiki_1249

…nto contributing_wiki_1249

unjust · 2023-06-26T14:07:38Z

CONTRIBUTING.md

+TODO: donde mencionamos el siguiente:
+
+Dependiendo de la naturaleza del contenido, se decidirán los detalles
+exactos ya que no todos los proyectos o tópicos tienen la misma naturaleza._


Aun estoy pensando donde poner eso.

unjust · 2023-06-26T14:11:16Z

contributing/TOPICS.md

+
+Estructura de archivos de un tópico:
+
+<!-- TODO: revisa con alpi -->


Quiero verificar que lo de abajo aun esta una estructura valida de un topic.
He observado que los directorios unidades no tienen README.md - son un directorio para partes no mas.

unjust · 2023-06-26T14:14:03Z

contributing/TOPICS.md

+Una manera de familiarizarse con la estructura de este archivo es ver 
+[este ejemplo de template](https://github.com/Laboratoria/bootcamp/blob/main/topics/_template/README.md).
+
+El `README` debe tener:


Abajo con esta lista necesito tus 👀 . Intente separar requisitos con "partes adicionales" que a veces parecen. Tambien hay algunos secciones que solo aparecen en los unidades (no los topicos en general) por ejemplo Objetivos de aprendiaje. Por favor me avisan si estoy equivocado. Mira que estoy usando ~~para tachar~~.

unjust · 2023-06-26T14:15:15Z

contributing/TOPICS.md

+<!-- ~* Objetivos de aprendizaje (`learningObjectives`)~ _required_ solo veo en unidades -->
+<!-- * Guía de preguntas y conceptos clave (`keyConcepts`) solo en unidades -->


Estoy tachando Publico objetivo.
Y solo veo esos partes de "OAs" y "Preguntas claves" en unidades de topicos (no en topicos).
Me parece los Objetivos pueden ser requistios porque estan en todo los unidades creo, pero no se si las pruebas exigen.

unjust · 2023-06-26T14:15:48Z

contributing/TOPICS.md

+~* Evaluación (`grading`)~ _required_
+~* Contribuidores (`contributors`)~ _required_


No los veo esos partes. Quitamos?

unjust · 2023-06-26T14:22:26Z

contributing/TOPICS.md

+1. Track de tópico `track` (`web-dev`, `ux`, etc)
+2. Título(`title`) _required_


Me parece que Track y Titulo son requisitos. Hay algun otro front-matter mas que track?

unjust · 2023-06-26T14:22:42Z

contributing/TOPICS.md

+~* Descripción (`description`)~ _required_
+~* Tags: (`tags`)~ _required_ <!-- mira functional js -->


Me parece que descripcion y tags ya no usamos o exigimos, esta bien si omitimos o aun sirve un funcion?

unjust · 2023-06-26T14:25:55Z

contributing/TOPICS.md

+tópico y que contiene el contenido de partes.
+
+
+<!-- TODO: Me parece que solo los unidades de ejercicios tiene un README con


Me parece que solo los unidades de ejercicios tiene un README con front matter de duracion. Es asi?

unjust · 2023-06-26T14:27:30Z

contributing/TOPICS.md

+Recomendamos que cada unidad empiece con una parte _lectura_ de **apertura** o
+**opening** y termine con una de **cierre** o **closing**. 
+Por ejemplo, la unidad 01 arriba tiene `00-apertura`, `06-cierre`.


hay apertura y cierra? solo veo opening and closing como nombres de directrios - son en ingles.
Tambien me pregunto si los nombres de carpetas y archivos, unidades y partes debe tener nombres en ingles o no es importante?

unjust · 2023-06-26T14:28:37Z

contributing/TOPICS.md

+Cada parte es un directorio dentro un unidad, y debe tener
+su propio `README.md`. 
+
+El `README.md` debe tener:


Tambien abajo quiero ver cuales son required y no.
Como required entiendo que si o si necesitan seguir eso y es probable si no tienen va a causar un error con el parser.

unjust · 2023-06-26T14:29:15Z

contributing/TOPICS.md

+hr *
+body (el cuerpo/contenido)
+
+* obligatorio


Cuando sepa cuales son obligatorios voy a revisar ese grafica y *

unjust · 2023-06-26T14:29:48Z

contributing/TOPICS.md

+```
+Los tipos son `lectura/read`, `práctica/practice`, `cuestionario/quiz`,
+`self-paced` (Leer mas de tipos y formatos.)[]
+<!-- TODO: ingles o espanol para tipos -->


usamos ingles o espanol para los tipos type?

unjust · 2023-06-26T14:32:53Z

contributing/TOPICS.md

+│   │   │   │   └── un-ejercicio.spec.js
+│   │   │   └──README.md
+│   │   ├── 02-otro-ejercicio
+│   │   └── README.md************* // TODO describe que hace aqui?


Mi pregunta es cuando hay un README dentro un parte que tiene challenges - el readme solo contiene eso

--- type: practice duration: 30min --- # Ejercicios

No se si cumple un funcion o ese readme no es necesario.

Ejemplo topics/javascript/09-errors/05-practice/README.md

unjust · 2023-06-26T14:34:15Z

contributing/TOPICS.md

+pero son ellxs quienes dirigen la actividad.
+
+
+### Challenges 


este parte es completamente nuevo.
Seria bueno tener 👀

unjust · 2023-06-26T14:35:00Z

@lupomontero @mfdebian por ahora necesito respuestas/ayuda con mis preguntas en
contributing/TOPICS.md

unjust · 2023-06-30T14:52:55Z

Puedo usar eso como referencia de antes https://github.com/Laboratoria/bootcamp/blob/ab52c0af8130aa92d1feb564b4bfec664e4e7865/dist/topics/javascript.json y despues https://curriculum.laboratoria.la/data/topics.json

unjust added 3 commits November 18, 2022 11:18

agrega paso para dependencias a deployment

fd3e253

un start para contenido de contributing

17e6dce

add placeholders

98a4a25

unjust requested review from mfdebian and lupomontero November 18, 2022 16:25

unjust commented Nov 18, 2022

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

unjust added 2 commits November 18, 2022 13:32

links a wiki, learning objectives

136dd1b

corregir links target blank

444e8ab

unjust self-assigned this Nov 18, 2022

unjust linked an issue Nov 18, 2022 that may be closed by this pull request

Mejoramos instrucciones/READMEs de contributing, deployment, scripts #1249

Closed

Merge branch 'main' into contributing_wiki_1249

283a483

mfdebian linked an issue Nov 22, 2022 that may be closed by this pull request

Actualizar documento CONTRIBUTING.md #1265

Closed

unjust added this to the v5.6.0 milestone Nov 22, 2022

unjust added content Relacionado al contenido de proyectos y tópicos and removed content Relacionado al contenido de proyectos y tópicos labels Nov 22, 2022

lupomontero reviewed Nov 23, 2022

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

Merge branch 'main' into contributing_wiki_1249

5ae769d

unjust marked this pull request as draft February 7, 2023 19:38

unjust modified the milestones: v5.6.0, TBD Feb 7, 2023

unjust modified the milestones: 6.3, TBD Apr 18, 2023

unjust linked an issue May 2, 2023 that may be closed by this pull request

Mover contenido de wiki a repo (source tree) y actualizar info de proyectos #1069

Closed

unjust added 3 commits May 8, 2023 14:40

Merge branch 'main' of github.com:Laboratoria/bootcamp into contribut…

a4ff575

…ing_wiki_1249

revise contributing, separar partes de Topics y Projects

af96c72

Merge branch 'contributing_wiki_1249' of github.com:unjust/bootcamp i…

d27f83b

…nto contributing_wiki_1249

unjust modified the milestones: TBD, 6.3 May 11, 2023

unjust added help wanted Extra attention is needed content Relacionado al contenido de proyectos y tópicos labels May 11, 2023

unjust commented Jun 26, 2023

View reviewed changes

unjust modified the milestones: v6.4 , 7.0 - bootcamp -> curriculum, TBD Jun 30, 2023

unjust changed the base branch from main to next July 10, 2023 19:47

unjust modified the milestones: Next release, TBD Jul 20, 2023

unjust mentioned this pull request Jul 20, 2023

Actualizar parte de proyectos en el documento CONTRIBUTING.md #1480

Closed

unjust modified the milestones: TBD, next release Jul 24, 2023

unjust modified the milestones: next release, TBD Aug 7, 2023

unjust removed this from the TBD milestone Nov 13, 2023

unjust closed this Oct 15, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Changes to CONTRIBUTING.md #1261

Changes to CONTRIBUTING.md #1261

unjust commented Nov 18, 2022 •

edited

Loading

lupomontero left a comment

unjust Jun 26, 2023

unjust Jun 26, 2023

unjust Jun 26, 2023 •

edited

Loading

unjust Jun 26, 2023 •

edited

Loading

unjust Jun 26, 2023

unjust Jun 26, 2023

unjust Jun 26, 2023

unjust Jun 26, 2023

unjust Jun 26, 2023

unjust Jun 26, 2023

unjust Jun 26, 2023 •

edited

Loading

unjust Jun 26, 2023

unjust Jun 26, 2023

unjust Jun 26, 2023

unjust commented Jun 26, 2023

unjust commented Jun 30, 2023


		Estructura de archivos de un tópico:

		<!-- TODO: revisa con alpi -->

		<!-- ~* Objetivos de aprendizaje (`learningObjectives`)~ _required_ solo veo en unidades -->
		<!-- * Guía de preguntas y conceptos clave (`keyConcepts`) solo en unidades -->

		~* Evaluación (`grading`)~ _required_
		~* Contribuidores (`contributors`)~ _required_

		1. Track de tópico `track` (`web-dev`, `ux`, etc)
		2. Título(`title`) _required_

		~* Descripción (`description`)~ _required_
		~* Tags: (`tags`)~ _required_ <!-- mira functional js -->

		tópico y que contiene el contenido de partes.


		<!-- TODO: Me parece que solo los unidades de ejercicios tiene un README con

Changes to CONTRIBUTING.md #1261

Changes to CONTRIBUTING.md #1261

Conversation

unjust commented Nov 18, 2022 • edited Loading

lupomontero left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

unjust Jun 26, 2023 • edited Loading

Choose a reason for hiding this comment

unjust Jun 26, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

unjust Jun 26, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

unjust commented Jun 26, 2023

unjust commented Jun 30, 2023

unjust commented Nov 18, 2022 •

edited

Loading

unjust Jun 26, 2023 •

edited

Loading

unjust Jun 26, 2023 •

edited

Loading

unjust Jun 26, 2023 •

edited

Loading